Get User
AutomatR.AWS.Activities.GetUser
The "Get User" activity in AutomatR is part of the AWS IAM (Identity and Access Management) Users activities package, enabling automation processes to retrieve information about a specific IAM user. This activity streamlines the process of obtaining details about IAM users, enhancing the efficiency of automation workflows.
Properties
Name | Description |
---|---|
Input | |
Access Key ID | Provides the encrypted access key ID for your AWS account, enabling connection to the AWS IAM service. String variables containing the access key ID. |
Secret Access Key | Provides the encrypted secret access key for your AWS account, enabling connection to the AWS IAM service. String variables containing the secret access key. |
Region | Specifies the desired AWS region from which you want to retrieve IAM user information. Use the RegionEndpoint enumeration to set the region. |
User Name | Specifies the name of the IAM user for whom you want to retrieve information. String variables containing the IAM user name. |
Misc | |
Display Name | Provides a customizable name for the activity displayed in the workflow. The display name enhances clarity and organization within the automation project. String variable or argument containing the desired display name. |
Optional | |
Delay | Specifies the amount of time (in seconds) to wait before executing the "Get User" activity. Useful for handling synchronization issues. Integer variables containing the delay duration. Ex.: If the wait time is 1000 milliseconds or 1 sec, i.e., 1. |
Output | |
User | Stores the result in a variable of type User , providing details about the IAM user. Variables of type User for further processing. |
How to use:
- Drag and drop the "Get User" activity onto the workflow.
- Configure the properties by providing the required inputs, such as access key ID, secret access key, region, and IAM user name.
- Optionally, configure the delay and customize the display name.
- Execute the workflow to retrieve information about the specified IAM user.
Example: Consider an example where the "Get User" activity is used to retrieve information about an IAM user named "JohnDoe":
Get User:
Display Name: "Retrieve User Information"
Access Key ID: "**************"
Secret Access Key: "**************"
Region: "us-east-1"
User Name: "JohnDoe"
User: userDetails
In this example, the activity retrieves information about the IAM user "JohnDoe." The result is stored in the variable "userDetails" of type User
for further handling in the workflow.